home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / games / biglife3.zoo / biglife.doc next >
Text File  |  1993-12-20  |  20KB  |  519 lines
  1.              BigLife Version 3.00
  2.              ====================
  3.             A life player for big patterns
  4.  
  5.             Copyright © 1993 Owen Rees
  6.  
  7. Permission to use, copy and distribute BigLife is granted, provided that
  8. any distribution includes the .PRG .RSC and .DOC files in their original
  9. form. A moderate charge may be made for media, duplication, transmission
  10. etc.
  11.  
  12. Distributors may use their own judgement about how many patterns to
  13. include.
  14.  
  15. 0) Contents
  16.    1) How to use Biglife
  17.    2) File formats
  18.    3) What is 'Life', further reading, more patterns
  19.    4) About the author, acknowledgements, history, future etc.
  20.  
  21.  
  22. 1) How to use Biglife
  23.  
  24. It's a GEM program and I have tried to make the menus and dialogs easy
  25. to understand so that, if you want to, you can try it out without
  26. reading any further.
  27.  
  28. BIGLIFE.RSC must be in the current folder when you run BIGLIFE.PRG, keep
  29. them in the same folder to run from the desktop.
  30.  
  31. When it is loaded you get a GEM window with all the usual controls, and
  32. a menu bar. Here is a summary of the menu items followed by more
  33. detailed descriptions.
  34.  
  35. Desk:    About life...    Version number, data about the current pattern.
  36.     Desk accessories, if any.
  37.  
  38. File:    Clear        Clear the universe.
  39.     Revert        Revert to loaded pattern.
  40.     Load Xlife...    Clear universe and load Xlife file (formats below) 
  41.     Save Xlife...    Save universe as Xlife file (formats below)
  42.     Load IMG...    Clear universe and load IMG
  43.     Save IMG...    Save as IMG
  44.     Quit        For when you have had enough
  45.  
  46. Actions:Go        Run at selected speed until key press
  47.     Step        Do one generation
  48.     Redraw        Clear window and redraw pattern
  49.     Centre        Move centre of window to centre of pattern
  50.     Reset counters    Zero the generation and time counters
  51.  
  52. Options:Display...    Dialog to set the display style
  53.     Speed...    Dialog to set the speed limit
  54.     Rules...    Choose rules for life variants
  55.     Edges...    Set edges of universe
  56.     Show Info    Show generation number in title line
  57.  
  58. About Life...
  59.  
  60. Tells you:
  61.    the version number of the program and the name of the author,
  62.    the name of the current pattern,     ) editable fields
  63.    the 'owner' (creator) of the pattern ) see File format below
  64.    the first three comment lines        ) 
  65.    the cell count, generation number, the run time, average speed and
  66. average time to compute a generation.
  67.    the size and position of the pattern
  68.    the size and position of the window (in cells)
  69.    the size of the workspace and how much is in use: sizes of current
  70.        and previous patterns are given separately.
  71.  
  72. In Low resolution some of the information is omitted, and none of the
  73. fields are editable (so that you don't accidentally lose half the
  74. information.)
  75.  
  76.  
  77. Display dialog:
  78.  
  79. This lets you select the cell size for display, the cell and background
  80. colours and the function used to draw the display.
  81.  
  82. There is a selection of cell display sizes in two shapes so that you can
  83. choose reasonably square cells in low, medium or high resolution. This
  84. affects how much of the pattern you can see but not the pattern itself.
  85.  
  86. The squash factor determines how many life cells are mapped to each
  87. display cell. This allows you to see the overall shape of large
  88. patterns. The number is the length of the side of the square that maps
  89. to each display cell. For example, at squash factor 2, you see twice
  90. the width and twice the height but with less detail.
  91.  
  92. The colour stuff is really just for fun. The one with the black spot in
  93. the middle is the selected colour. I have only given you eight of the
  94. low res colours - you can only use two at a time anyway.
  95.  
  96. The VDI and LineA buttons select which function gets called to do the
  97. output. LineA is slightly faster but Atari has declared it obsolete.
  98. For the technically minded, the choice is between the VDI vrt_cpyfm
  99. and the Line A bitblt.
  100.  
  101.  
  102. Speed dialog:
  103.  
  104. This sets a speed limit, measured in generations per second. Max means
  105. as fast as possible and if selected BEFORE you select Go will disable
  106. all the controls until you press a key on the keyboard to stop the
  107. run.  With any other speed, the menus remain active. If you select Max
  108. while running, the menus remain active so you have to select Go again
  109. to get full speed.
  110.  
  111. Note that this is a speed limit rather than a delay between generations.
  112. All speeds above the speed at which the pattern can be computed are
  113. equivalent. The time taken to compute the new generation is subtracted
  114. from the delay.
  115.  
  116. Rules dialog:
  117.  
  118. The rules dialog lets you specify the birth and survival rules. Select
  119. which neighbour counts should cause a birth in a dead cell, and which
  120. neighbour counts should cause survival in a live cell. There are
  121. buttons to set the dialog to the standard rules and to the 3-4 rules -
  122. one of the better known variations.
  123.  
  124. Edges dialog:
  125.  
  126. The edges dialog lets you specify smaller universes, with either open
  127. or connected edges. All cells beyond an open edge are permanently
  128. dead. A connected edge acts as if it were next to the opposite edge of
  129. the universe. By connecting one or both pairs of edges, the universe
  130. can be made cylindrical or toroidal. Specifying 'no edge' is
  131. equivalent to open edges at -32767 and 32767 except for the way scroll
  132. bars operate. Specifying edges slows things down.
  133.  
  134. Window controls:
  135.  
  136. The close box does the same as Quit in the File menu. The title shows
  137. the name of the loaded file and, optionally, the number of generations
  138. since load (or counter reset). The generation counter will be updated
  139. dynamically if there is enough time. The full box, size box and move bar
  140. do the usual resizing and moving.
  141.  
  142. If edges have been specified, the scroll bars show the size and
  143. position of the window relative to the universe - it can be hard to
  144. find a small pattern in a large universe with edges turned on.
  145.  
  146. If 'no edge' has been specified, the scroll bars show you the size and
  147. position of the window over an area that includes the pattern plus a
  148. border the height/width of the window, and also includes the window
  149. itself. This may sound a bit odd but try loading the glider, scrolling
  150. the window so that it is in the top left corner (you need the border
  151. to be able to do that) then let it run for about 10 seconds at maximum
  152. speed. The glider crosses the screen and disappears into the distance.
  153. When you stop it, the scroll bars show that you are looking at the
  154. corner of a large area.  Scroll the window towards the pattern and the
  155. scroll bars start to get bigger until you get to the pattern again.
  156.  
  157. If you set a slow enough speed limit, the scroll bars will change
  158. dynamically as the pattern evolves.
  159.  
  160.  
  161. Pattern editing:
  162.  
  163. There is a very primitive and slow pattern editing facility. Pressing
  164. the left mouse button makes the cell under the pointer live, pressing
  165. the right mouse button makes it dead.
  166.  
  167.  
  168. 2) File Formats
  169.  
  170. Biglife will read and write the Xlife file format. (Xlife is a freely
  171. available life player for the X Window System.) It will also read and
  172. write IMG format files.
  173.  
  174. Loading Xlife:
  175.  
  176. The file consists of a number of pattern sections which are merged to
  177. make the complete pattern. The file, and any additional files from
  178. which patterns are included, are read to form a load script. This
  179. script is then processed to build the pattern. The 'Revert' menu item
  180. rebuilds the pattern from the script - this can take a long time for
  181. some pattern scripts.
  182.  
  183. Each section starts with a header line that
  184. starts with a '#' followed by a format character that specifies the
  185. format of the section.
  186.  
  187. Biglife supports the following section formats:
  188.  
  189. A -- Absolute. The header is followed by lines consisting of a pair of
  190. numbers that specify absolute (x,y) coordinates. For example, a row of
  191. three cells centred on (10,10) would appear as:
  192.  
  193. #A
  194. 9 10
  195. 10 10
  196. 11 10
  197.  
  198. R -- Relative. Like absolute but with an offset specified on the
  199. header line. If the offset is omitted it is taken to be 0 0. The same
  200. row of three cells could be specified as:
  201.  
  202. #R 10 10
  203. -1 0
  204. 0 0
  205. 1 0
  206.  
  207. P -- Picture. Each following line down to a line that starts with # or
  208. to the end of the file is interpreted as a scan line of an image
  209. s